<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Class NcOptOption | HiAPI-C# 2025 </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Class NcOptOption | HiAPI-C# 2025 ">
      
      <meta name="description" content="Represents the optimization options for NC operations.">
      <link rel="icon" href="../img/HiAPI.favicon.ico">
      <link rel="stylesheet" href="../public/docfx.min.css">
      <link rel="stylesheet" href="../public/main.css">
      <meta name="docfx:navrel" content="../toc.html">
      <meta name="docfx:tocrel" content="toc.html">
      
      <meta name="docfx:rel" content="../">
      
      
      
      <meta name="loc:inThisArticle" content="In this article">
      <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
      <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
      <meta name="loc:tocFilter" content="Filter by title">
      <meta name="loc:nextArticle" content="Next">
      <meta name="loc:prevArticle" content="Previous">
      <meta name="loc:themeLight" content="Light">
      <meta name="loc:themeDark" content="Dark">
      <meta name="loc:themeAuto" content="Auto">
      <meta name="loc:changeTheme" content="Change theme">
      <meta name="loc:copy" content="Copy">
      <meta name="loc:downloadPdf" content="Download PDF">

      <script type="module" src="./../public/docfx.min.js"></script>

      <script>
        const theme = localStorage.getItem('theme') || 'auto'
        document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
      </script>

  </head>

  <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
    <header class="bg-body border-bottom">
      <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
        <div class="container-xxl flex-nowrap">
          <a class="navbar-brand" href="../index.html">
            <img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
            
          </a>
          <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
            <i class="bi bi-three-dots"></i>
          </button>
          <div class="collapse navbar-collapse" id="navpanel">
            <div id="navbar">
              <form class="search" role="search" id="search">
                <i class="bi bi-search"></i>
                <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
              </form>
            </div>
          </div>
        </div>
      </nav>
    </header>

    <main class="container-xxl">
      <div class="toc-offcanvas">
        <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
          <div class="offcanvas-header">
            <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
            <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
          </div>
          <div class="offcanvas-body">
            <nav class="toc" id="toc"></nav>
          </div>
        </div>
      </div>

      <div class="content">
        <div class="actionbar">
          <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
            <i class="bi bi-list"></i>
          </button>

          <nav id="breadcrumb"></nav>
        </div>

        <article data-uid="Hi.NcOpt.NcOptOption">



  <h1 id="Hi_NcOpt_NcOptOption" data-uid="Hi.NcOpt.NcOptOption" class="text-break">
Class NcOptOption  
  </h1>

  <div class="facts text-secondary">
    <dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcOpt.html">NcOpt</a></dd></dl>
  <dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
  </div>

  <div class="markdown summary"><p>Represents the optimization options for NC operations.</p>
</div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class NcOptOption : IMakeXmlSource, IEquatable&lt;NcOptOption&gt;, IToXElement</code></pre>
  </div>




  <dl class="typelist inheritance">
    <dt>Inheritance</dt>
    <dd>
      <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
      <div><span class="xref">NcOptOption</span></div>
    </dd>
  </dl>

  <dl class="typelist implements">
    <dt>Implements</dt>
    <dd>
      <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
      <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a>&gt;</div>
      <div><a class="xref" href="Hi.Common.XmlUtils.IToXElement.html">IToXElement</a></div>
    </dd>
  </dl>


  <dl class="typelist inheritedMembers">
    <dt>Inherited Members</dt>
    <dd>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
    </div>
  </dd></dl>

  <dl class="typelist extensionMethods">
    <dt>Extension Methods</dt>
    <dd>
  <div>
      <a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
  </div>
  </dd></dl>





  <h2 class="section" id="constructors">Constructors
</h2>


  <a id="Hi_NcOpt_NcOptOption__ctor_" data-uid="Hi.NcOpt.NcOptOption.#ctor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption__ctor" data-uid="Hi.NcOpt.NcOptOption.#ctor">
  NcOptOption()
  
  </h3>

  <div class="markdown level1 summary"><p>Ctor.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public NcOptOption()</code></pre>
  </div>













  <a id="Hi_NcOpt_NcOptOption__ctor_" data-uid="Hi.NcOpt.NcOptOption.#ctor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption__ctor_Hi_NcOpt_NcOptOption_" data-uid="Hi.NcOpt.NcOptOption.#ctor(Hi.NcOpt.NcOptOption)">
  NcOptOption(NcOptOption)
  
  </h3>

  <div class="markdown level1 summary"><p>Copy Ctor.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public NcOptOption(NcOptOption src)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>src</code> <a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a></dt>
    <dd><p>src</p>
</dd>
  </dl>












  <a id="Hi_NcOpt_NcOptOption__ctor_" data-uid="Hi.NcOpt.NcOptOption.#ctor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcOpt.NcOptOption.#ctor(System.Xml.Linq.XElement)">
  NcOptOption(XElement)
  
  </h3>

  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a> class from XML.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public NcOptOption(XElement src)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
    <dd><p>The XML element containing the option data.</p>
</dd>
  </dl>












  <h2 class="section" id="properties">Properties
</h2>


  <a id="Hi_NcOpt_NcOptOption_CompensationMask_" data-uid="Hi.NcOpt.NcOptOption.CompensationMask*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_CompensationMask" data-uid="Hi.NcOpt.NcOptOption.CompensationMask">
  CompensationMask
  
  </h3>

  <div class="markdown level1 summary"><p>Internal Use Only.
Gets or sets the compensation mask for axis compensation.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int CompensationMask { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_EnableDepthCompensation_" data-uid="Hi.NcOpt.NcOptOption.EnableDepthCompensation*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_EnableDepthCompensation" data-uid="Hi.NcOpt.NcOptOption.EnableDepthCompensation">
  EnableDepthCompensation
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets whether depth compensation is enabled.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool EnableDepthCompensation { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_EnableDepthSplition_" data-uid="Hi.NcOpt.NcOptOption.EnableDepthSplition*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_EnableDepthSplition" data-uid="Hi.NcOpt.NcOptOption.EnableDepthSplition">
  EnableDepthSplition
  
  </h3>

  <div class="markdown level1 summary"><p>Enables or disables depth splitting optimization.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool EnableDepthSplition { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_EnableForwardCompensation_" data-uid="Hi.NcOpt.NcOptOption.EnableForwardCompensation*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_EnableForwardCompensation" data-uid="Hi.NcOpt.NcOptOption.EnableForwardCompensation">
  EnableForwardCompensation
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets whether forward compensation is enabled.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool EnableForwardCompensation { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_EnableInterpolation_" data-uid="Hi.NcOpt.NcOptOption.EnableInterpolation*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_EnableInterpolation" data-uid="Hi.NcOpt.NcOptOption.EnableInterpolation">
  EnableInterpolation
  
  </h3>

  <div class="markdown level1 summary"><p>Enables or disables interpolation.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool EnableInterpolation { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_EnableOpt_" data-uid="Hi.NcOpt.NcOptOption.EnableOpt*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_EnableOpt" data-uid="Hi.NcOpt.NcOptOption.EnableOpt">
  EnableOpt
  
  </h3>

  <div class="markdown level1 summary"><p>Enables or disables the optimization process.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool EnableOpt { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_EnableOptFeedrate_" data-uid="Hi.NcOpt.NcOptOption.EnableOptFeedrate*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_EnableOptFeedrate" data-uid="Hi.NcOpt.NcOptOption.EnableOptFeedrate">
  EnableOptFeedrate
  
  </h3>

  <div class="markdown level1 summary"><p>Enables or disables feedrate optimization.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool EnableOptFeedrate { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_EnableSideCompensation_" data-uid="Hi.NcOpt.NcOptOption.EnableSideCompensation*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_EnableSideCompensation" data-uid="Hi.NcOpt.NcOptOption.EnableSideCompensation">
  EnableSideCompensation
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets whether side compensation is enabled.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool EnableSideCompensation { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_ExtendedPostDistance_mm_" data-uid="Hi.NcOpt.NcOptOption.ExtendedPostDistance_mm*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_ExtendedPostDistance_mm" data-uid="Hi.NcOpt.NcOptOption.ExtendedPostDistance_mm">
  ExtendedPostDistance_mm
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the extended post-distance in millimeters.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double ExtendedPostDistance_mm { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_ExtendedPreDistance_mm_" data-uid="Hi.NcOpt.NcOptOption.ExtendedPreDistance_mm*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_ExtendedPreDistance_mm" data-uid="Hi.NcOpt.NcOptOption.ExtendedPreDistance_mm">
  ExtendedPreDistance_mm
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the extended pre-distance in millimeters.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double ExtendedPreDistance_mm { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_FeedrateAssignmentRatio_" data-uid="Hi.NcOpt.NcOptOption.FeedrateAssignmentRatio*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_FeedrateAssignmentRatio" data-uid="Hi.NcOpt.NcOptOption.FeedrateAssignmentRatio">
  FeedrateAssignmentRatio
  
  </h3>

  <div class="markdown level1 summary"><p>The option takes effect if <a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_EnableInterpolation">EnableInterpolation</a> is true.
If the feedrate changing exceeds this ratio, the Feedrate in the NC line will be updated.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double FeedrateAssignmentRatio { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_IsPreferFuncIndexDictionaryCalled_" data-uid="Hi.NcOpt.NcOptOption.IsPreferFuncIndexDictionaryCalled*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_IsPreferFuncIndexDictionaryCalled" data-uid="Hi.NcOpt.NcOptOption.IsPreferFuncIndexDictionaryCalled">
  IsPreferFuncIndexDictionaryCalled
  
  </h3>

  <div class="markdown level1 summary"><p>Internal Use Only.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsPreferFuncIndexDictionaryCalled { get; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MaxAcceleration_mmds2_" data-uid="Hi.NcOpt.NcOptOption.MaxAcceleration_mmds2*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MaxAcceleration_mmds2" data-uid="Hi.NcOpt.NcOptOption.MaxAcceleration_mmds2">
  MaxAcceleration_mmds2
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the maximum acceleration in millimeters per second squared.
The typical CNC lathe or machining center has an acceleration of 0.2g (2 m/sec2).
High speed machines have accelerations up to 2g (20 m/sec2).
An arbitrary value 10mm/s2 is chosen for initial value.
Note: 600mm/min=10mm/s.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MaxAcceleration_mmds2 { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MaxFeedPerTooth_mm_" data-uid="Hi.NcOpt.NcOptOption.MaxFeedPerTooth_mm*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MaxFeedPerTooth_mm" data-uid="Hi.NcOpt.NcOptOption.MaxFeedPerTooth_mm">
  MaxFeedPerTooth_mm
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the maximum feed per tooth in millimeters.
By the principle of conservation,
if the value is different from the <a class="xref" href="Hi.NcOpt.IFeedPerToothOptLimit.html">IFeedPerToothOptLimit</a>.<a class="xref" href="Hi.NcOpt.IFeedPerToothOptLimit.html#Hi_NcOpt_IFeedPerToothOptLimit_GetMaxFeedPerTooth_mm">GetMaxFeedPerTooth_mm()</a>,
The smaller value will be applied in the optimization process.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MaxFeedPerTooth_mm { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MaxFeedrate_mmdmin_" data-uid="Hi.NcOpt.NcOptOption.MaxFeedrate_mmdmin*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MaxFeedrate_mmdmin" data-uid="Hi.NcOpt.NcOptOption.MaxFeedrate_mmdmin">
  MaxFeedrate_mmdmin
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the maximum feedrate in millimeters per minute.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MaxFeedrate_mmdmin { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MaxFeedrate_mmds_" data-uid="Hi.NcOpt.NcOptOption.MaxFeedrate_mmds*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MaxFeedrate_mmds" data-uid="Hi.NcOpt.NcOptOption.MaxFeedrate_mmds">
  MaxFeedrate_mmds
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the maximum feedrate in millimeters per second.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MaxFeedrate_mmds { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MaxJerk_mmds3_" data-uid="Hi.NcOpt.NcOptOption.MaxJerk_mmds3*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MaxJerk_mmds3" data-uid="Hi.NcOpt.NcOptOption.MaxJerk_mmds3">
  MaxJerk_mmds3
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the maximum jerk in millimeters per second cubed.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MaxJerk_mmds3 { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MinFeedPerTooth_mm_" data-uid="Hi.NcOpt.NcOptOption.MinFeedPerTooth_mm*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MinFeedPerTooth_mm" data-uid="Hi.NcOpt.NcOptOption.MinFeedPerTooth_mm">
  MinFeedPerTooth_mm
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the minimum feed per tooth in millimeters.
By the principle of conservation,
if the value is different from the <a class="xref" href="Hi.NcOpt.IFeedPerToothOptLimit.html">IFeedPerToothOptLimit</a>.<a class="xref" href="Hi.NcOpt.IFeedPerToothOptLimit.html#Hi_NcOpt_IFeedPerToothOptLimit_GetMinFeedPerTooth_mm">GetMinFeedPerTooth_mm()</a>,
The larger value will be applied in the optimization process.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MinFeedPerTooth_mm { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MinFeedrate_mmdmin_" data-uid="Hi.NcOpt.NcOptOption.MinFeedrate_mmdmin*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MinFeedrate_mmdmin" data-uid="Hi.NcOpt.NcOptOption.MinFeedrate_mmdmin">
  MinFeedrate_mmdmin
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the minimum feedrate in millimeters per minute.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MinFeedrate_mmdmin { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_MinFeedrate_mmds_" data-uid="Hi.NcOpt.NcOptOption.MinFeedrate_mmds*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MinFeedrate_mmds" data-uid="Hi.NcOpt.NcOptOption.MinFeedrate_mmds">
  MinFeedrate_mmds
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the minimum feedrate in millimeters per second.
The principle of conversation is applied for
feedrate setting (MinFeedrate_mmds and <a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_MaxFeedrate_mmds">MaxFeedrate_mmds</a>) and
feed per tooth setting (<a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_MinFeedPerTooth_mm">MinFeedPerTooth_mm</a> and <a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_MaxFeedPerTooth_mm">MaxFeedPerTooth_mm</a>).
If feed per tooth setting is not in the range of feedrate setting,
The feedrate setting takes priority.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double MinFeedrate_mmds { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_PreferedForce_N_" data-uid="Hi.NcOpt.NcOptOption.PreferedForce_N*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_PreferedForce_N" data-uid="Hi.NcOpt.NcOptOption.PreferedForce_N">
  PreferedForce_N
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the preferred force in Newtons.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double PreferedForce_N { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_RapidFeed_mmdmin_" data-uid="Hi.NcOpt.NcOptOption.RapidFeed_mmdmin*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_RapidFeed_mmdmin" data-uid="Hi.NcOpt.NcOptOption.RapidFeed_mmdmin">
  RapidFeed_mmdmin
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the rapid feed rate in millimeters per minute.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double RapidFeed_mmdmin { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_RapidFeed_mmds_" data-uid="Hi.NcOpt.NcOptOption.RapidFeed_mmds*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_RapidFeed_mmds" data-uid="Hi.NcOpt.NcOptOption.RapidFeed_mmds">
  RapidFeed_mmds
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the rapid feed rate in millimeters per second.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double RapidFeed_mmds { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_SpindlePowerSafetyFactor_" data-uid="Hi.NcOpt.NcOptOption.SpindlePowerSafetyFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_SpindlePowerSafetyFactor" data-uid="Hi.NcOpt.NcOptOption.SpindlePowerSafetyFactor">
  SpindlePowerSafetyFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the safety factor for spindle power.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double SpindlePowerSafetyFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_SpindlePowerUtilizationFactor_" data-uid="Hi.NcOpt.NcOptOption.SpindlePowerUtilizationFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_SpindlePowerUtilizationFactor" data-uid="Hi.NcOpt.NcOptOption.SpindlePowerUtilizationFactor">
  SpindlePowerUtilizationFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the utilization factor for spindle power.
It is the reciprocal of <a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_SpindlePowerSafetyFactor">SpindlePowerSafetyFactor</a>.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double SpindlePowerUtilizationFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_SpindleTorqueSafetyFactor_" data-uid="Hi.NcOpt.NcOptOption.SpindleTorqueSafetyFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_SpindleTorqueSafetyFactor" data-uid="Hi.NcOpt.NcOptOption.SpindleTorqueSafetyFactor">
  SpindleTorqueSafetyFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the safety factor for spindle torque.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double SpindleTorqueSafetyFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_SpindleTorqueUtilizationFactor_" data-uid="Hi.NcOpt.NcOptOption.SpindleTorqueUtilizationFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_SpindleTorqueUtilizationFactor" data-uid="Hi.NcOpt.NcOptOption.SpindleTorqueUtilizationFactor">
  SpindleTorqueUtilizationFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the utilization factor for spindle torque.
It is the reciprocal of <a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_SpindleTorqueSafetyFactor">SpindleTorqueSafetyFactor</a>.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double SpindleTorqueUtilizationFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_ThermalYieldSafetyFactor_" data-uid="Hi.NcOpt.NcOptOption.ThermalYieldSafetyFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_ThermalYieldSafetyFactor" data-uid="Hi.NcOpt.NcOptOption.ThermalYieldSafetyFactor">
  ThermalYieldSafetyFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the safety factor for cutter thermal yield.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double ThermalYieldSafetyFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_ThermalYieldUtilizationFactor_" data-uid="Hi.NcOpt.NcOptOption.ThermalYieldUtilizationFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_ThermalYieldUtilizationFactor" data-uid="Hi.NcOpt.NcOptOption.ThermalYieldUtilizationFactor">
  ThermalYieldUtilizationFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the safety bound for cutter thermal yield.
It is the reciprocal of <a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_ThermalYieldSafetyFactor">ThermalYieldSafetyFactor</a>.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double ThermalYieldUtilizationFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_XName_" data-uid="Hi.NcOpt.NcOptOption.XName*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_XName" data-uid="Hi.NcOpt.NcOptOption.XName">
  XName
  
  </h3>

  <div class="markdown level1 summary"><p>Name for XML IO.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static string XName { get; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_YieldingSafetyFactor_" data-uid="Hi.NcOpt.NcOptOption.YieldingSafetyFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_YieldingSafetyFactor" data-uid="Hi.NcOpt.NcOptOption.YieldingSafetyFactor">
  YieldingSafetyFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the safety factor for yielding.
By the principle of conservation,
if the value is different from the <a class="xref" href="Hi.NcOpt.MillingCutterOptOption.html">MillingCutterOptOption</a>.<a class="xref" href="Hi.NcOpt.MillingCutterOptOption.html#Hi_NcOpt_MillingCutterOptOption_YieldingSafetyFactor">YieldingSafetyFactor</a>,
The larger value will be applied in the optimization process.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double YieldingSafetyFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcOpt_NcOptOption_YieldingUtilizationFactor_" data-uid="Hi.NcOpt.NcOptOption.YieldingUtilizationFactor*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_YieldingUtilizationFactor" data-uid="Hi.NcOpt.NcOptOption.YieldingUtilizationFactor">
  YieldingUtilizationFactor
  
  </h3>

  <div class="markdown level1 summary"><p>Gets or sets the utilization factor for yielding.
It is the reciprocal of <a class="xref" href="Hi.NcOpt.NcOptOption.html#Hi_NcOpt_NcOptOption_YieldingSafetyFactor">YieldingSafetyFactor</a>.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double YieldingUtilizationFactor { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd></dd>
  </dl>








  <h2 class="section" id="methods">Methods
</h2>


  <a id="Hi_NcOpt_NcOptOption_CallPreferFuncIndexDictionary_" data-uid="Hi.NcOpt.NcOptOption.CallPreferFuncIndexDictionary*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_CallPreferFuncIndexDictionary" data-uid="Hi.NcOpt.NcOptOption.CallPreferFuncIndexDictionary">
  CallPreferFuncIndexDictionary()
  
  </h3>

  <div class="markdown level1 summary"><p>Calls and returns the prefer function index dictionary, initializing it if it is null.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Dictionary&lt;Func&lt;MillingPhysicsBrief, double&gt;, double&gt; CallPreferFuncIndexDictionary()</code></pre>
  </div>


  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="Hi.MillingForces.MillingPhysicsBrief.html">MillingPhysicsBrief</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
    <dd><p>The prefer function index dictionary.</p>
</dd>
  </dl>











  <a id="Hi_NcOpt_NcOptOption_Duplicate_" data-uid="Hi.NcOpt.NcOptOption.Duplicate*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_Duplicate" data-uid="Hi.NcOpt.NcOptOption.Duplicate">
  Duplicate()
  
  </h3>

  <div class="markdown level1 summary"><p>Creates a new instance of NcOptOption by duplicating the current instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public NcOptOption Duplicate()</code></pre>
  </div>


  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a></dt>
    <dd><p>A new NcOptOption instance with the same values as the current instance.</p>
</dd>
  </dl>











  <a id="Hi_NcOpt_NcOptOption_Equals_" data-uid="Hi.NcOpt.NcOptOption.Equals*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_Equals_Hi_NcOpt_NcOptOption_" data-uid="Hi.NcOpt.NcOptOption.Equals(Hi.NcOpt.NcOptOption)">
  Equals(NcOptOption)
  
  </h3>

  <div class="markdown level1 summary"><p>Indicates whether the current object is equal to another object of the same type.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Equals(NcOptOption other)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>other</code> <a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a></dt>
    <dd><p>An object to compare with this object.</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
  </dl>











  <a id="Hi_NcOpt_NcOptOption_Equals_" data-uid="Hi.NcOpt.NcOptOption.Equals*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_Equals_System_Object_" data-uid="Hi.NcOpt.NcOptOption.Equals(System.Object)">
  Equals(object)
  
  </h3>

  <div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
    <dd><p>The object to compare with the current object.</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object  is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
  </dl>











  <a id="Hi_NcOpt_NcOptOption_GetHashCode_" data-uid="Hi.NcOpt.NcOptOption.GetHashCode*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_GetHashCode" data-uid="Hi.NcOpt.NcOptOption.GetHashCode">
  GetHashCode()
  
  </h3>

  <div class="markdown level1 summary"><p>Serves as the default hash function.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
  </div>


  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
    <dd><p>A hash code for the current object.</p>
</dd>
  </dl>











  <a id="Hi_NcOpt_NcOptOption_MakeXmlSource_" data-uid="Hi.NcOpt.NcOptOption.MakeXmlSource*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcOpt.NcOptOption.MakeXmlSource(System.String,System.String,System.Boolean)">
  MakeXmlSource(string, string, bool)
  
  </h3>

  <div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
    <dd><p>The base directory for resolving relative paths</p>
</dd>
    <dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
    <dd><p>The relative file path for the XML source</p>
</dd>
    <dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p>if true, the extended file creation is suppressed.</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
    <dd><p>An XML element representing the object's state</p>
</dd>
  </dl>







  <h4 class="section" id="Hi_NcOpt_NcOptOption_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
  <div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>




  <a id="Hi_NcOpt_NcOptOption_ToXElement_" data-uid="Hi.NcOpt.NcOptOption.ToXElement*"></a>

  <h3 id="Hi_NcOpt_NcOptOption_ToXElement" data-uid="Hi.NcOpt.NcOptOption.ToXElement">
  ToXElement()
  
  </h3>

  <div class="markdown level1 summary"><p>Get the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a> to represent the object.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public XElement ToXElement()</code></pre>
  </div>


  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
    <dd><p><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a> to represent the object.</p>
</dd>
  </dl>












</article>

        <div class="contribution d-print-none">
        </div>


      </div>

      <div class="affix">
        <nav id="affix"></nav>
      </div>
    </main>

    <div class="container-xxl search-results" id="search-results"></div>

    <footer class="border-top text-secondary">
      <div class="container-xxl">
        <div class="flex-fill">
          <span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
        </div>
      </div>
    </footer>
  </body>
</html>
